API

Logistics APIs

GET logistics/shipping-services/{shippingServiceId}

Details for provided shipping service

HTTP method GET
URI https://api.rambase.net/logistics/shipping-services/{shippingServiceId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {shippingServiceId} Shipping service identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 2092, version 18

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ShippingService>
2
     <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
3
     <Status
Status

Status of shipping service

Possible domain values can be found here

>{Integer}</Status>
4
     <Name
Name

Name of shipping service

>{String}</Name>
5
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
     <Description
Description

Description of shipping service

>{String}</Description>
7
     <Direction
Direction

Direction of goods for this shipping service. Is goods arriving by this shipping service (INCOMING), or is departing (OUTGOING).

Possible domain values can be found here

>{String}</Direction>
8
     <IsAvailableExternal
IsAvailableExternal

True if shipping service should be visibile in external systems. An example of an external system might be a web site.

>{Boolean}</IsAvailableExternal>
9
     <DepartingWaybillConsolidationTag
DepartingWaybillConsolidationTag

All shipping services with same consolidation tag will be consolidated when creating departing waybills for shipping advices, supplier returns and goods transfers. Example of consolidation tag might be "UPSNORDIC".

>{String}</DepartingWaybillConsolidationTag>
10
     <PayersCustomerIdAtCarrier
PayersCustomerIdAtCarrier

Customers account ID at the carrier for the given shippingservice

>{String}</PayersCustomerIdAtCarrier>
11
     <PayersCustomerIdAtReturnCarrier
PayersCustomerIdAtReturnCarrier

The customer account id (at the carrier) that should pay for return of shipments sihpped with this shipping service. It is typically the customer.

This field is greyed out because it is an expandable field. You have to add $expand=PayersCustomerIdAtReturnCarrier in your request URI to get this field

>{String}</PayersCustomerIdAtReturnCarrier>
12
     <Carrier>
13
          <CarrierId
CarrierId

Carrier identifier

>{Integer}</CarrierId>
14
          <Name
Name

Name of carrier

This field is greyed out because it is an expandable field. You have to add $expand=Carrier.Name in your request URI to get this field

>{String}</Name>
15
          <CarrierLink
CarrierLink

Carrier reference

>{String}</CarrierLink>
16
     </Carrier>
17
     <CarrierService>
18
          <CarrierServiceId
CarrierServiceId

Shipping service identifier from arhive for shipping services

>{Integer}</CarrierServiceId>
19
          <CarriersId
CarriersId

Carrier service identifier

This field is greyed out because it is an expandable field. You have to add $expand=CarrierService.CarriersId in your request URI to get this field

>{String}</CarriersId>
20
          <Description
Description

Description of the carriers shipping service

This field is greyed out because it is an expandable field. You have to add $expand=CarrierService.Description in your request URI to get this field

>{String}</Description>
21
          <CarrierServiceLink
CarrierServiceLink

Service reference

>{String}</CarrierServiceLink>
22
     </CarrierService>
23
     <ExclusivelyForCustomer
ExclusivelyForCustomer

Some shipping services are exclusively for one customer only.

>
24
          <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
25
          <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyForCustomer.Name in your request URI to get this field

>{String}</Name>
26
          <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
27
     </ExclusivelyForCustomer>
28
     <ReturnShippingService
ReturnShippingService

The shipping service that should be used when shipments that are shipped with this shipping service are returned. For instance you might not have to use an expensive express delivery for the return of products.

>
29
          <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
30
          <Name
Name

Name of shipping service

>{String}</Name>
31
          <ReturnShppingServiceLink
ReturnShppingServiceLink

Shipping service reference

>{String}</ReturnShppingServiceLink>
32
     </ReturnShippingService>
33
     <ActiveTrackingNumberSeries
ActiveTrackingNumberSeries

This field is greyed out because it is an expandable field. You have to add $expand=ActiveTrackingNumberSeries in your request URI to get this field

>
34
          <TrackingNumberSeries
TrackingNumberSeries

This field is greyed out because it is an expandable field. You have to add $expand=ActiveTrackingNumberSeries in your request URI to get this field

>
35
               <TrackingNumberSeriesId
TrackingNumberSeriesId

Tracking number series identifier

This field is greyed out because it is an expandable field. You have to add $expand=ActiveTrackingNumberSeries in your request URI to get this field

>{Integer}</TrackingNumberSeriesId>
36
               <Type
Type

Tells if this serial of tracking number is to be allocated to each package ("PACKAGE") or for at total shipment ("SHIPMENT")

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ActiveTrackingNumberSeries in your request URI to get this field

>{String}</Type>
37
               <TrackingNumberLink
TrackingNumberLink

Tracking number series reference

This field is greyed out because it is an expandable field. You have to add $expand=ActiveTrackingNumberSeries in your request URI to get this field

>{String}</TrackingNumberLink>
38
          </TrackingNumberSeries>
39
     </ActiveTrackingNumberSeries>
40
</ShippingService>
1
{
2
     "shippingService": {
3
          "shippingServiceId
ShippingServiceId

Shipping service identifier

": "{Integer}",
4
          "status
Status

Status of shipping service

Possible domain values can be found here

": "{Integer}",
5
          "name
Name

Name of shipping service

": "{String}",
6
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
          "description
Description

Description of shipping service

": "{String}",
8
          "direction
Direction

Direction of goods for this shipping service. Is goods arriving by this shipping service (INCOMING), or is departing (OUTGOING).

Possible domain values can be found here

": "{String}",
9
          "isAvailableExternal
IsAvailableExternal

True if shipping service should be visibile in external systems. An example of an external system might be a web site.

": "{Boolean}",
10
          "departingWaybillConsolidationTag
DepartingWaybillConsolidationTag

All shipping services with same consolidation tag will be consolidated when creating departing waybills for shipping advices, supplier returns and goods transfers. Example of consolidation tag might be "UPSNORDIC".

": "{String}",
11
          "payersCustomerIdAtCarrier
PayersCustomerIdAtCarrier

Customers account ID at the carrier for the given shippingservice

": "{String}",
12
          "payersCustomerIdAtReturnCarrier
PayersCustomerIdAtReturnCarrier

The customer account id (at the carrier) that should pay for return of shipments sihpped with this shipping service. It is typically the customer.

This field is greyed out because it is an expandable field. You have to add $expand=PayersCustomerIdAtReturnCarrier in your request URI to get this field

": "{String}",
13
          "carrier": {
14
               "carrierId
CarrierId

Carrier identifier

": "{Integer}",
15
               "name
Name

Name of carrier

This field is greyed out because it is an expandable field. You have to add $expand=Carrier.Name in your request URI to get this field

": "{String}",
16
               "carrierLink
CarrierLink

Carrier reference

": "{String}"
17
          },
18
          "carrierService": {
19
               "carrierServiceId
CarrierServiceId

Shipping service identifier from arhive for shipping services

": "{Integer}",
20
               "carriersId
CarriersId

Carrier service identifier

This field is greyed out because it is an expandable field. You have to add $expand=CarrierService.CarriersId in your request URI to get this field

": "{String}",
21
               "description
Description

Description of the carriers shipping service

This field is greyed out because it is an expandable field. You have to add $expand=CarrierService.Description in your request URI to get this field

": "{String}",
22
               "carrierServiceLink
CarrierServiceLink

Service reference

": "{String}"
23
          },
24
          "exclusivelyForCustomer
ExclusivelyForCustomer

Some shipping services are exclusively for one customer only.

": {
25
               "customerId
CustomerId

Customer identifier

": "{Integer}",
26
               "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

This field is greyed out because it is an expandable field. You have to add $expand=ExclusivelyForCustomer.Name in your request URI to get this field

": "{String}",
27
               "customerLink
CustomerLink

Customer reference

": "{String}"
28
          },
29
          "returnShippingService
ReturnShippingService

The shipping service that should be used when shipments that are shipped with this shipping service are returned. For instance you might not have to use an expensive express delivery for the return of products.

": {
30
               "shippingServiceId
ShippingServiceId

Shipping service identifier

": "{Integer}",
31
               "name
Name

Name of shipping service

": "{String}",
32
               "returnShppingServiceLink
ReturnShppingServiceLink

Shipping service reference

": "{String}"
33
          },
34
          "activeTrackingNumberSeries
ActiveTrackingNumberSeries

This field is greyed out because it is an expandable field. You have to add $expand=ActiveTrackingNumberSeries in your request URI to get this field

": [
35
               {
36
                    "trackingNumberSeriesId
TrackingNumberSeriesId

Tracking number series identifier

This field is greyed out because it is an expandable field. You have to add $expand=ActiveTrackingNumberSeries in your request URI to get this field

": "{Integer}",
37
                    "type
Type

Tells if this serial of tracking number is to be allocated to each package ("PACKAGE") or for at total shipment ("SHIPMENT")

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ActiveTrackingNumberSeries in your request URI to get this field

": "{String}",
38
                    "trackingNumberLink
TrackingNumberLink

Tracking number series reference

This field is greyed out because it is an expandable field. You have to add $expand=ActiveTrackingNumberSeries in your request URI to get this field

": "{String}"
39
               }
40
          ]
41
     }
42
}

Possible error codes the response might return:

Error 102738 HTTP 404 Price list not found
Error 100055 HTTP 403 You have only admittance to your own objects